home *** CD-ROM | disk | FTP | other *** search
/ IBM InfoROM for OS/2 Beta 1995 January / IBM InfoROM for OS2 Beta 1-1995.ISO / testcert / mmedia / system / ap2 / install.hlp (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1994-05-19  |  15.9 KB  |  446 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Installation ΓòÉΓòÉΓòÉ
  3.  
  4. Enter the path where you want to install AP2 (C:\AP2 by default).  The AP2 
  5. program files and scripts will then be installed on your  hard drives. 
  6.  
  7. Consult any of the following sections for information on AP2. 
  8.  
  9. o  Introduction 
  10. o  How to use AP2 
  11. o  Test Case Output 
  12. o  Error Messages 
  13. o  P2String 
  14. o  CDXA 
  15.  
  16.  
  17. ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
  18.  
  19. AP2 automates the testing of audio device drivers using P2String. It first 
  20. tests the default device driver's capabilities (if the option is checked) and 
  21. then displays a list of test cases that the device supports. You can select 
  22. several test cases to run. At the end of each test case, AP2 displays the 
  23. status of that test case (success or failure). 
  24.  
  25. This Help file is composed of the following sections: 
  26.  
  27. o  Introduction 
  28. o  How to use AP2 
  29. o  Test Case Output 
  30. o  The Description File 
  31. o  Error Messages 
  32. o  P2String 
  33. o  CDXA 
  34.  
  35.  
  36. ΓòÉΓòÉΓòÉ 3. How to use AP2 ΓòÉΓòÉΓòÉ
  37.  
  38. o  Command Line Arguments 
  39. o  Testing 
  40. o  Device Capabilities 
  41. o  The Stop Button 
  42. o  The View Output Button 
  43. o  The DataPath Button 
  44.  
  45.  
  46. ΓòÉΓòÉΓòÉ 3.1. Command Line Arguments ΓòÉΓòÉΓòÉ
  47.  
  48. When running AP2, it can be invoked by simply typing AP2, or by using any of 
  49. the following arguments: 
  50.  
  51. o  SCRIPTS 
  52. o  /ALL 
  53. o  /AMPMIX 
  54. o  /CD 
  55. o  /CDXA 
  56. o  /MIDI 
  57. o  /VIDEO 
  58. o  /WAVE 
  59. o  /INTERACTIVE 
  60. o  /BATCH 
  61. o  /TEST 
  62. o  /NOTEST 
  63. o  /DATAPATH 
  64. o  /O 
  65.  
  66.  
  67. ΓòÉΓòÉΓòÉ 3.1.1. SCRIPTS ΓòÉΓòÉΓòÉ
  68.  
  69. Specifying The SCRIPTS Parameter will load into AP2 All scripts that match the 
  70. filename given for SCRIPTS.  Wildcards "*" and "?" are supported. 
  71.  
  72. If no switches are used to designate which files are to be selected, then all 
  73. the loaded SCRIPTS will be selected.  Otherwise, only those scripts matching 
  74. the selection switches will be highlighted. 
  75.  
  76.  
  77. ΓòÉΓòÉΓòÉ 3.1.2. /ALL ΓòÉΓòÉΓòÉ
  78.  
  79. Specifying The /ALL Switch will select ALL scripts that are displayed. If the 
  80. /BATCH switch is used in conjunction with /ALL, the selected scripts will be 
  81. tested. 
  82.  
  83.  
  84. ΓòÉΓòÉΓòÉ 3.1.3. /AMPMIX ΓòÉΓòÉΓòÉ
  85.  
  86. Specifying The /AMPMIX Switch will select all AMPMIX scripts that are 
  87. displayed. If the /BATCH switch is used in conjunction with /AMPMIX, the 
  88. selected scripts will be tested. 
  89.  
  90. AMPMIX scripts are identified by the first letter of the filename beginning 
  91. with "A". 
  92.  
  93.  
  94. ΓòÉΓòÉΓòÉ 3.1.4. /CD ΓòÉΓòÉΓòÉ
  95.  
  96. Specifying The /CD Switch will select all CD scripts that are displayed. If the 
  97. /BATCH switch is used in conjunction with /CD, the selected scripts will be 
  98. tested. 
  99.  
  100. CD scripts are identified by the first letter of the filename beginning with 
  101. "C". 
  102.  
  103.  
  104. ΓòÉΓòÉΓòÉ 3.1.5. /CDXA ΓòÉΓòÉΓòÉ
  105.  
  106. Specifying The /CDXA Switch will select all CDXA scripts that are displayed. If 
  107. the /BATCH switch is used in conjunction with /CDXA, the selected scripts will 
  108. be tested. 
  109.  
  110. CDXA scripts are identified by the first letter of the filename beginning with 
  111. "X". 
  112.  
  113.  
  114. ΓòÉΓòÉΓòÉ 3.1.6. /MIDI ΓòÉΓòÉΓòÉ
  115.  
  116. Specifying The /MIDI Switch will select all MIDI scripts that are displayed. If 
  117. the /BATCH switch is used in conjunction with /MIDI, the selected scripts will 
  118. be tested. 
  119.  
  120. MIDI scripts are identified by the first letter of the filename beginning with 
  121. "M". 
  122.  
  123.  
  124. ΓòÉΓòÉΓòÉ 3.1.7. /VIDEO ΓòÉΓòÉΓòÉ
  125.  
  126. Specifying The /VIDEO Switch will select all VIDEO scripts that are displayed. 
  127. If the /BATCH switch is used in conjunction with /VIDEO, the selected scripts 
  128. will be tested. 
  129.  
  130. VIDEO scripts are identified by the first letter of the filename beginning with 
  131. "V". 
  132.  
  133.  
  134. ΓòÉΓòÉΓòÉ 3.1.8. /WAVE ΓòÉΓòÉΓòÉ
  135.  
  136. Specifying The /WAVE Switch will select all WAVE scripts that are displayed. If 
  137. the /BATCH switch is used in conjunction with /WAVE, the selected scripts will 
  138. be tested. 
  139.  
  140. WAVE scripts are identified by the first letter of the filename beginning with 
  141. "W". 
  142.  
  143.  
  144. ΓòÉΓòÉΓòÉ 3.1.9. /INTERACTIVE ΓòÉΓòÉΓòÉ
  145.  
  146. Specifying The /INTERACTIVE Switch will select all INTERACTIVE scripts that are 
  147. displayed. If the /BATCH switch is used in conjunction with /INTERACTIVE, then 
  148. the Interactive switch will be ignored. 
  149.  
  150. A file is designated as Interactive if the seventh character in its filename is 
  151. an "I". For example: C1____I1.P2S.  A file should be designated as interactive 
  152. if it uses the @BREAK or the @CHECK P2String Directive. 
  153.  
  154.  
  155. ΓòÉΓòÉΓòÉ 3.1.10. /BATCH ΓòÉΓòÉΓòÉ
  156.  
  157. Specifying the /BATCH switch will run AP2 in a Batch Mode.  When running AP2 
  158. batch, no user interaction is required, nor is it necessary.  The program will 
  159. run, test all scripts, and automatically terminate when there is an error, or 
  160. when all scripts have been tested. 
  161.  
  162. To run in Batch mode, it is required to specify which scripts are to be tested. 
  163. Use any combination of the previous seven switches.  Specifying /VIDEO /WAVE 
  164. /BATCH will automatically test all video and wave scripts and terminate when 
  165. done. 
  166.  
  167. All errors and failed scripts are logged to an OUTPUT file.  The output file 
  168. can be specified with the /O switch. If no output file is specified, AP2.OUT 
  169. will be the default. 
  170.  
  171. In Batch Mode, testing Device Capabilities is defaulted to on, unless the 
  172. /NOTEST switch is specified. 
  173.  
  174. During Batch execution, only those files not designated by their naming 
  175. convention as INTERACTIVE are run.  A file is designated as interactive if the 
  176. seventh character in its filename is an "I".  For example: C1____I1.P2S.  A 
  177. file should be designated as interactive if it uses the @BREAK or the @CHECK 
  178. P2String Directive. 
  179.  
  180.  
  181. ΓòÉΓòÉΓòÉ 3.1.11. /TEST ΓòÉΓòÉΓòÉ
  182.  
  183. Specifying the /TEST switch will automatically test Device Capabilities at 
  184. startup. This setting will also be saved.  The next time AP2 is run, AP2 will 
  185. test the capabilities, unless this option is turned off. 
  186.  
  187.  
  188. ΓòÉΓòÉΓòÉ 3.1.12. /NOTEST ΓòÉΓòÉΓòÉ
  189.  
  190. Specifying the /NOTEST switch will turn off automatically testing Device 
  191. Capabilities at startup. This setting will also be saved.  The next time AP2 is 
  192. run, AP2 will not test the capabilities, unless this option is turned on. 
  193.  
  194.  
  195. ΓòÉΓòÉΓòÉ 3.1.13. /DATAPATH ΓòÉΓòÉΓòÉ
  196.  
  197. The /DATAPATH switch is used to specify the directory used for the datafiles. 
  198. Specifying the DataPath switch is the same as pressing the DataPath button. 
  199.  
  200. To set the DataPath to "C:\DATA" use the following switch: 
  201.  
  202. /DATAPATH=C:\DATA 
  203.  
  204.  
  205. ΓòÉΓòÉΓòÉ 3.1.14. /O ΓòÉΓòÉΓòÉ
  206.  
  207. The /O switch is used to specify an OUTPUT FILE file for AP2.  The output file 
  208. will contain the output generated from all P2String scripts that FAIL.  The 
  209. output file will also report the number of scripts that SUCCEEDED and FAILED. 
  210. When running in BATCH Mode, all errors will also be logged to this file. 
  211.  
  212. To set the Output File to "MYTEST.OUT" use the following switch: 
  213.  
  214. /OMYTEST.OUT 
  215.  
  216. Note: There is no spaces betweeon the /O and the filename. 
  217.  
  218.  
  219. ΓòÉΓòÉΓòÉ 3.2. Testing ΓòÉΓòÉΓòÉ
  220.  
  221. You can select several test cases.  You can also use the All or the None button 
  222. to select all or none of the test cases, respectively. 
  223.  
  224. Press the Start Test button to start running the test cases you selected.  As 
  225. each test case terminates, the result of the test is displayed in the list box 
  226. (success or failure). 
  227.  
  228.  
  229. ΓòÉΓòÉΓòÉ 3.3. Device Capabilities ΓòÉΓòÉΓòÉ
  230.  
  231. AP2 starts by testing the audio device driver's capabilities.  According to the 
  232. outcome of the device capability testing, only the supported test cases will be 
  233. displayed.  If you are familiar with P2String, you can view the file 
  234. CAPABLTY.TXT, which lists the outcome of the device capablility testing. 
  235.  
  236. You can disable device capability testing by unchecking the appropriate check 
  237. box in the main window.  In that case, all test cases will be displayed, 
  238. regardless of whether the device supports their functions or not. 
  239.  
  240. Capabilities tested include: 
  241.  
  242. Wave Audio 
  243.  
  244.    o Record 
  245.    o Save 
  246.    o Set the volume 
  247.    o PCM: (8 or 16 bits per sample -- 11k,22k, or 44k samples per second -- 
  248.      mono or stereo -- play or record) 
  249.    o ADPCM: (16 bits per sample -- 11k,22k, or 44k samples per second -- mono 
  250.      or stereo -- play or record) 
  251.    o ALAW: (8 bits per sample -- 11k,22k, or 44k samples per second -- mono or 
  252.      stereo -- play or record) 
  253.    o MULAW: (8 bits per sample -- 11k,22k, or 44k samples per second -- mono or 
  254.      stereo -- play or record) 
  255.  
  256.  MIDI 
  257.  
  258.    o Play 
  259.    o Save 
  260.    o Set the volume 
  261.  
  262.  CD Audio 
  263.  
  264.    o Play 
  265.    o Eject 
  266.    o Lock the Eject button 
  267.    o Set the volume 
  268.    o Stream 
  269.  
  270.  CDXA 
  271.  
  272.    o Play 
  273.    o Eject 
  274.    o Lock the Eject button 
  275.    o Set the volume 
  276.  
  277.  VIDEO 
  278.  
  279.    o Play 
  280.    o Record 
  281.    o Set the volume 
  282.  
  283.  
  284. ΓòÉΓòÉΓòÉ 3.4. The Stop button ΓòÉΓòÉΓòÉ
  285.  
  286. The Stop button allows interruption of testing. This can be helpful if many 
  287. files are highlighted and the Start Test button was pressed by mistake.  It can 
  288. also be used if the first in a series of related test cases fails.  In that 
  289. case, there might be no reason to run the remaining test cases. 
  290.  
  291. The viewing process can be interrupted in the same fashion. 
  292.  
  293.  
  294. ΓòÉΓòÉΓòÉ 3.5. The View Output button ΓòÉΓòÉΓòÉ
  295.  
  296. The View Output button allows the viewing of the *.OUT files that are generated 
  297. from the execution of the *.P2S files. 
  298.  
  299. To view the output for a specified script, highlight the script, and click on 
  300. the VIEW OUTPUT Button. 
  301.  
  302.  
  303. ΓòÉΓòÉΓòÉ 3.6. The DataPath button ΓòÉΓòÉΓòÉ
  304.  
  305. The DataPath button allows the selection of a directory where Datafiles 
  306. necessary for the execution of scripts are located. When the DataPath button is 
  307. pressed, a standard Directory Dialog box is presented.  Any directory on any 
  308. drive can be specified.  Datafiles consist of *.WAV, *.MID, *.AVI, etc. 
  309.  
  310. All the datafiles must exist in the same directory.  If Datafiles are spread 
  311. among more that one directory, it is not possible to test all the scripts at 
  312. once using the DataPath. 
  313.  
  314. Note for Script writers: When AP2 executes P2String, it passes it an 
  315. environment Variable AP2PATH which the script writer will use when specifying a 
  316. datafile.  If the file TEST.WAV is to be used, it would appear as follows: 
  317. ?AP2PATH?TEST.WAV with no spaces between the question mark and the filename. 
  318.  
  319.  
  320. ΓòÉΓòÉΓòÉ 4. Test Case Output ΓòÉΓòÉΓòÉ
  321.  
  322. The P2String output files have the same name as the test cases, but have the 
  323. extension ".OUT".  They are located in the current directory. Subsequent 
  324. execution of the same test case will overwrite the old ".OUT" file 
  325.  
  326. Delete unnecessary output files at any time. 
  327.  
  328. RECORD test cases will save wave files in a file called "DELETE.WAV".  Video 
  329. RECORD will save files called "DELETE.AVI".  These files will be overwritten by 
  330. subsequent RECORD test cases.  The "DELETE.WAV" and the "DELETE.AVI" files can 
  331. be erased at any time 
  332.  
  333. Note that a test case that says Error is not necessarily failing.  Test cases 
  334. with the text "FAILED" are not working correctly. 
  335.  
  336.  
  337. ΓòÉΓòÉΓòÉ 5. The Description File ΓòÉΓòÉΓòÉ
  338.  
  339. AP2 Uses a file P2S_DESC.TXT to read in the descriptions for the P2String 
  340. scripts in the current directory.  Each description is to be on only one line. 
  341. The format for the file is the script filename followed by a ":" followed by a 
  342. description.  If the description is over 256 characters, it will be trimmed to 
  343. 256, or the maximum length available to the Window.  An example of a 
  344. description file follows: 
  345.  
  346. A______1.P2S : Ampmix Test #1
  347. A______2.P2S : Ampmix Test #2
  348.  
  349. If there is no matching description for a test script, the script will be 
  350. shown, but without a description.  If the P2S_DESC.TXT file does not exist, 
  351. there will be no descriptions for the test scripts. 
  352.  
  353.  
  354. ΓòÉΓòÉΓòÉ 6. Error Messages ΓòÉΓòÉΓòÉ
  355.  
  356. The following is a list of all error messages the program generates: 
  357.  
  358. o Help Not Available.  This error message appears if the AP2.HLP file is 
  359.   missing 
  360.  
  361.  
  362. o Help Terminated Due to Error.  This error message appears if the program 
  363.   encounters an error while loading the help file 
  364.  
  365.  
  366. o Unable to create file:  CAPABLTY.TXT.  This error message appears if the 
  367.   program can not create the named file.  This could happen if you were trying 
  368.   to run the program from a read-only medium 
  369.  
  370.  
  371. o Could not find test cases.  This error message appears if no test cases were 
  372.   found in the currrent directory.  Test cases have a ".P2S" extension 
  373.  
  374.  
  375. o Device driver does not support test cases.  This error message appears if the 
  376.   program determines that none of the available test cases are supported by the 
  377.   device driver 
  378.  
  379.  
  380. o Error Opening AP2.INI, file not found.  This error message appears if the 
  381.   AP2.INI file can not be found in the current directory 
  382.  
  383.  
  384. o Error Reading AP2.INI.  This error message appears if an error occured while 
  385.   reading from the AP2.INI file.  Restore the AP2.INI file from your original 
  386.   disk. 
  387.  
  388.  
  389. o Error writing AP2.INI.  This error message appears when the program is trying 
  390.   to update the settings for AP2.  This could happen if you were trying to run 
  391.   the program on a read-only medium. 
  392.  
  393.  
  394. o DataPath is Invalid.  Please choose a new one.  This error message appears if 
  395.   the DataPath is invalid.  You will be prompted to select a new DataPath after 
  396.   selecting OK. 
  397.  
  398.  
  399. o No DataPath specified.  Press ENTER to quit AP2.  This error message appears 
  400.   if there was an invalid DataPath, and a valid one was not chosen. 
  401.  
  402.  
  403. o Memory Allocation Error.  You should probably close your apps and shutdown 
  404.   your system when you see this message 
  405.  
  406.  
  407. o Error starting P2STRING.  This error message appears when P2String.EXE can 
  408.   not be found on the path 
  409.  
  410.  
  411. o Error opening file filename.  This error message appears when the program 
  412.   fails to open the named output file 
  413.  
  414.  
  415. o Error reading file filename.  This error message appears when the program 
  416.   fails to read the named output file 
  417.  
  418.  
  419. o Error closing file filename.  This error message appears when the program 
  420.   fails to close the named output file 
  421.  
  422.  
  423. o Error starting the Editor.  This error message appears when the program can 
  424.   not find the standard editor 
  425.  
  426.  
  427. ΓòÉΓòÉΓòÉ 7. P2String ΓòÉΓòÉΓòÉ
  428.  
  429. P2String script processing tool is used to test the mci (media control 
  430. interface) string commands in the MMPM/2 environment. 
  431.  
  432. You can find information on P2String in the .INF file that comes with the 
  433. P2String tool.  For more information on P2String, refer to the  MMPM/2 Device 
  434. Driver Source Kit for OS/2  or the  Multimedia Presentation Manager Toolkit/2 
  435. Subsystem Development Guide  manuals. 
  436.  
  437.  
  438. ΓòÉΓòÉΓòÉ 8. CDXA ΓòÉΓòÉΓòÉ
  439.  
  440. CDXA test cases require path and filename information.  Before running any of 
  441. the test cases for the first time, use an editor to fill-in that information. 
  442. CDXA test cases start with an X and have a .P2S extension. The CDXA test cases 
  443. clearly indicate where to change this information 
  444.  
  445. Please note that CDXA test cases will fail (or not be available) if the audio 
  446. card does not support AVC ADPCM wave audio format